de.cebis.moccabox.repository
Interface IRepository

All Known Implementing Classes:
RepositoryImpl

public interface IRepository

Interface, das die Informationen über die Komponenten sowie die Zugriffsoperatoren darauf kapselt. Das IRepository ist die zentrale Komponente, in die die Meta-Informationen der Anwendung geschrieben und später daraus gelesen werden. Es werden alle registrierten VOs sowie weitere Angaben über den Programmverlauf in ihr verwaltet.

Author:
weichelt

Method Summary
 void addValidator(java.lang.String id, com.opensymphony.xwork.validator.Validator validator)
          Hinzufügen eins Validator für die Validierung von Nutzereingaben.
 void addView(java.lang.String id, View view)
          Hinzufügen einer View für die Repräsentation von Abstraktionen.
 BusinessTaskBean getBusinessTaskBean(java.lang.String command)
          Zurückliefern des BusinessTaskBean für einen bestimmten Befehl.
 BusinessTaskBean[] getBusinessTaskBeans()
          Zurückliefern der Liste aller registrierter und spezifizierter Vorgänge im Repository.
 BusinessTaskContextBean getBusinessTaskContextBean(java.lang.String contextName)
          Zurückliefern der Beschreibung und Spezifikation eines bestimmten Kontextes.
 BusinessTaskContextBean[] getBusinessTaskContextBeans()
          Zurückliefern der Liste aller registrierten und spezifizierten Kontexte im Repository.
 java.lang.String getCommandForStatus(java.lang.String command, java.lang.String status)
          Zurückliefern eines Folge-Befehls für einen erreichten Status einer Ausführung.
 MetaSystemBean getMonitor()
          Zurückliefern des registrierten Integritätsmonitors.
 TaskStatusBean getTaskStatusBean(java.lang.String command, java.lang.String status)
          Zurückliefern eines spezifizierten Status für die Ausführung eines Vorgangs.
 void init()
          Initialisieren der Komponente.
 void logStatus()
          Schreiben des aktuellen Status in ein Log-File.
 void registerBusinessTaskContext(BusinessTaskContextBean businessTaskContext)
          Registrieren der Spezifikation eines Kontextes.
 void registerCommand(BusinessTaskBean commandBean)
          Registrieren der Spezifikation eines Vorgangs.
 void registerMonitor(MetaSystemBean metaSystem)
          Registrieren des Integritätsmonitors.
 void resolveReferences()
          Auflösen der Referenzen, die zwischen den einzelnen Einträgen innerhalb des Repository bestehen.
 

Method Detail

getBusinessTaskBean

BusinessTaskBean getBusinessTaskBean(java.lang.String command)
                                     throws InvalidCommandException
Zurückliefern des BusinessTaskBean für einen bestimmten Befehl.

Parameters:
command - Das übergebene Kommando.
Returns:
Das korresondierende BusinessTaskBean, dass alle Informationen über das für die Ausführung des Vorgangs für den übergebenen Befehl enthält.
Throws:
InvalidCommandException - Der Befehl ist nicht registriert.

getCommandForStatus

java.lang.String getCommandForStatus(java.lang.String command,
                                     java.lang.String status)
                                     throws InvalidCommandException
Zurückliefern eines Folge-Befehls für einen erreichten Status einer Ausführung.

Parameters:
command - Der Befehl, der aktuell ausgeführt wurde.
status - Der Status, der bei der Ausführung erreicht wurde.
Returns:
Der Befehl, der im Anschluss des Workflow ausgeführt werden soll.
Throws:
InvalidCommandException - Der Befehl ist nicht registriert.

getBusinessTaskBeans

BusinessTaskBean[] getBusinessTaskBeans()
Zurückliefern der Liste aller registrierter und spezifizierter Vorgänge im Repository.

Returns:
Liste aller Vorgänge.

getBusinessTaskContextBean

BusinessTaskContextBean getBusinessTaskContextBean(java.lang.String contextName)
Zurückliefern der Beschreibung und Spezifikation eines bestimmten Kontextes.

Parameters:
contextName - Der Name des Kontext, dessen Spezifikation angefordert wird.
Returns:
Die Beschreibung des Kontextes.

getBusinessTaskContextBeans

BusinessTaskContextBean[] getBusinessTaskContextBeans()
Zurückliefern der Liste aller registrierten und spezifizierten Kontexte im Repository.

Returns:
Liste der Kontexte.

getTaskStatusBean

TaskStatusBean getTaskStatusBean(java.lang.String command,
                                 java.lang.String status)
                                 throws InvalidCommandException
Zurückliefern eines spezifizierten Status für die Ausführung eines Vorgangs.

Parameters:
command - Befehl der aktuell ausgeführt wird.
status - Status, der bei der Ausführung des Befehls erreicht wurde.
Returns:
Die korrespondierende Status-Beschreibung.
Throws:
InvalidCommandException - Der Befehl ist nicht registriert.

logStatus

void logStatus()
Schreiben des aktuellen Status in ein Log-File.


registerCommand

void registerCommand(BusinessTaskBean commandBean)
Registrieren der Spezifikation eines Vorgangs.

Parameters:
commandBean - Spezifikation des zu registrierenden Vorgangs.

registerBusinessTaskContext

void registerBusinessTaskContext(BusinessTaskContextBean businessTaskContext)
Registrieren der Spezifikation eines Kontextes.

Parameters:
businessTaskContext - Spezifikation des zu registrierenden Kontextes.

addView

void addView(java.lang.String id,
             View view)
Hinzufügen einer View für die Repräsentation von Abstraktionen.

Parameters:
id - Identifikator der View.
view - Die zu registrierende View.

addValidator

void addValidator(java.lang.String id,
                  com.opensymphony.xwork.validator.Validator validator)
Hinzufügen eins Validator für die Validierung von Nutzereingaben.

Parameters:
id - Identifikator des Validator.
validator - Der zu registrierende Validator.

resolveReferences

void resolveReferences()
Auflösen der Referenzen, die zwischen den einzelnen Einträgen innerhalb des Repository bestehen. Da die Komponenten aus unterschiedlichen Quellen gelesen werden und dem Repository hinzugefügt werden, können Querverweise und Referenzen erst aufgelöst werden, nachdem alle Komponenten eingelesen wurden. Nur so kann vermieden werden, dass in Spezifikationsdateien (z.B. moccapart_x.xml) Spezifikationen redundant gehalten werden müssen. Stattdessen kann zwischen verschiedenen Dateien quer verwiesen werden (z.B. auf die View 'template', die in einem anderen File spezifiziert ist).


registerMonitor

void registerMonitor(MetaSystemBean metaSystem)
Registrieren des Integritätsmonitors.

Parameters:
metaSystem - Der zu registrierende Integritätsmonitor.

getMonitor

MetaSystemBean getMonitor()
Zurückliefern des registrierten Integritätsmonitors.

Returns:
Der registrierte Integritätsmonitor.

init

void init()
Initialisieren der Komponente.